2. Installation overview
In the previous step we ensure that the Windows server or PC meet the minimum requirements for an Axiell Collections installation, and that IIS and the .NET Framework are set up correctly.
Now we are ready to install the three components of an Axiell Collections on-premises solution:
Axiell Collections requires:
- A Microsoft SQL Server or SQL Server Express database.
Any SQL database supported by Microsoft can be used, but we recommended using the latest version1.
Tip: When installing SQL Server Express, accept the default settings.
- Install SQL Server Management Studio to .
Tip: Accept the default settings when installing SQL Server Management Studio.
Details about minimum requirements and how to install and configure Microsoft SQL Server can be found here.
Create a folder on the server in which to deploy the Collections application, Axiell Designer and the Axiell Collections web service. In this example, we call it:
C:\Collections
Within this folder, copy the latest version of the following resources:
This is the collections management heart of Axiell Collections. Different models of the Collections application are available for different types of collection:
- archive
- library
- museum
and for combinations of collection types:
- archive+library
- archive+museum
- library+museum
The XPlus variant is designed for organizations with all three types of collection:
- archive+library+museum
Upgrading Adlib for Windows
An existing Adlib for Windows installation can be upgraded to Axiell Collections. In this case the Collections application is effectively already installed and it is only necessary to make the Adlib for Windows application Axiell Collections ready.
Where to get the installation package
For new customers and fresh installations of Axiell Collections:
- Axiell will provide customers with the latest release of the Collections application model suited to their collections management needs.
- Axiell staff can download the latest Collections application release (the Axiell Collections Help desk can provide details of the download location).
The installation package is a folder (with a name such as Model Application) containing a number of sub folders and files, which together make up a Collections application.
Typically, Axiell staff install the application and associate it with the SQL database.
Note: Details about the Collections application folder structure and files can be found here.
Install
To install the Collections application, copy the folder holding the Collections application to the server and rename it as required, e.g.:
C:\Collections\Collections Application
Much of the Administration of Axiell Collections is performed with Axiell Designer.
Where to get the installation files
Axiell will provide the latest version of Axiell Designer or customers can download it from the Axiell Collections Support site.
The installation package is a folder called Axiell Designer
containing a number of sub folders and files.
Install
To install Axiell Designer, copy the Axiell Designer
folder to the server, e.g.:
C:\Collections\Axiell Designer
Tip: You may want to create a desktop short cut to the Axiell Designer executable.
Restoring a pre-configured SQL database backup file is a quick way to set up a database for Axiell Collections.
Axiell has backup databases with and without demo data.
Save the backup file (it will have a .bak
extension) to your Collections folder, e.g. C:\Collections.
Where to get the SQL database backup files
- Axiell will provide customers with the latest SQL database backup file by Axiell.
- Axiell staff can download the latest SQL database backup file (the Axiell Collections Help desk can provide details of the download location).
Note: If you don't restore a database, you will need to create a new database.
Also known as the Axiell Collections core software, this is deployed in IIS (Internet Information Services) as the Axiell Collections web service; it includes configuration files that point to the Collections application and database.
The Axiell Collections software installation package is provided as a zip file:
- In your Collections folder, create a sub-folder called, for example, Axiell Collections.
- Save the zip file to this folder, e.g. C:\Collections\Axiell Collections
Where to get the installation files (Axiell staff)
Axiell staff can download the latest Axiell Collections core software release (the Axiell Collections Help desk can provide details of the download location).
Your Collections directory will be similar to this:
The quickest way to set up a SQL database for Axiell Collections is to restore a pre-configured SQL database backup file (with or without demo data) provided by Axiell. In the following steps we restore a database.
If you do not restore a database, you will need to create a new database.
Note: See 3. Installing SQL Server for details about supported versions of SQL Server, minimum requirements, installing SQL Server, creating a new database, and methods of authentication.
To restore a database:
- Open SQL Server Management Studio (SSMS).
Tip: If using a PC running a Windows operating system such as Windows 10 rather than a Windows Server, be sure to run the SSMS as an Administrator (e.g. right-click the SSMS program icon and select Run as Administrator.
- Connect to the SQL Server using Windows Authentication:
- Create a new database or restore a database.
See 3. Installing SQL Server for details about creating a new database.
- Right-click Databases and select Restore Database:
- In the Restore Database window:
- Select the Device radio button.
- Click the ellipsis to navigate to the .bak file copied to the server (e.g. in C:\Collections):
- In the Select backup devices window:
In the Restore Database window:
Keep SQL Server Management Studio open for the next step.
In Step 5, we connect the Collections application to the SQL database. There are two methods to authenticate the connection to the database:
- SQL Server authentication
-OR-
- Windows authentication (using Active Directory)
To give a user / group access to the database, we can use an existing user or create a new user. Here we create a new user:
- In SQL Server Management Studio, expand Security, right click Logins and select New Login from the context menu:
- Specify the user / group:Use Windows authentication
Select the Windows authentication option and enter a user name or Active Directory group in Login name:
-OR-
Use SQL server authenticationSelect the SQL Server authentication option, enter a name in Login name, and add and then confirm a password:
We'll be using these user details in Step 5.
Select User Mapping, place a tick by the Database name and the role the user will have (typically db_owner):
- Click OK and close SQL Server Management Studio.
Finally, we need to connect the Collections application to the database:
- Start Axiell Designer and click the Open application browser button.
The Application browser window will display.
We need to point Axiell Designer at the Collections application folder on the server.
- Click the Change application browser folder button, browse to the folder containing the Collections application files (called
Collections Application
in this example) and click OK: - In the left-hand pane of Axiell Designer, expand the folder tree, expand the data folder and select any one of the listed table definitions:
- In the right-hand pane, scroll down to the Data storage section of the page.
- In the Data Source Name field, enter the name of the database you created or connected to (here).
- Press TAB to move to the Server field.
A message displays asking if you want to adjust the settings of all other databases:
Click Cancel for now.
Note: We only click OK when all required fields in the Data storage section have been completed.
- In the Server field, enter the name of the SQL Server you connected to (here).
- Press TAB to exit the field and again click Cancel in the message box that displays.
- If you specified Windows authentication in Step 4. SQL authentication, leave the username and password fields empty (when we test the connection to the database, the Windows credentials you are currently using to access the server / PC will be used).
-OR-
If you specified SQL server authentication, enter the user name and then password and press TAB to exit the field.
- This time when the message displays, click OK to apply the settings to all tables.
Tip: Click any of the other data sources in the data folder and check to confirm the server settings have updated.
In this demonstration, the values are:
- Click Test to check the connection.
You should receive an OK confirmation:
Note: If you created a new database at Step 3 above, a message about missing tables will display. See Step 8 below.
- Click Save all modified files and in the Save objects window ensure that all files are selected:
- Click Yes.
The Collections application and database are now connected.
-
This Step and Step 9 are only required if you created a new database at Step 3 above; when you ran the test, you will have received a message about missing tables. In this case, generate the required tables by right clicking the data directory in Designer and selecting Clear all databases in this folder:
Note: All data will be wiped if you use this option on an existing rather than new database!
-
Once the databases have been cleared, right click on the data directory, select Reindex all databases in this folder and click Start.
- Close Axiell Designer.